<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: req_interface/inc/fpc_timebase.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__timebase_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fpc_timebase.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Timebase based on a system tick.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="fpc__timebase_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9a06fbb5fce95e153a82d1d6084e31eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__timebase_8h.html#a9a06fbb5fce95e153a82d1d6084e31eb">fpc_timebase_get_tick</a> (void)</td></tr>
<tr class="memdesc:a9a06fbb5fce95e153a82d1d6084e31eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the system tick counter.  <a href="#a9a06fbb5fce95e153a82d1d6084e31eb">More...</a><br /></td></tr>
<tr class="separator:a9a06fbb5fce95e153a82d1d6084e31eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4344ced36900ee2a274f90fae673b8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__timebase_8h.html#ab4344ced36900ee2a274f90fae673b8d">fpc_timebase_delay_ms</a> (uint32_t ms)</td></tr>
<tr class="memdesc:ab4344ced36900ee2a274f90fae673b8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delay in milliseconds.  <a href="#ab4344ced36900ee2a274f90fae673b8d">More...</a><br /></td></tr>
<tr class="separator:ab4344ced36900ee2a274f90fae673b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fc231a5570eade1f6e819cfe02fa9a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__timebase_8h.html#a7fc231a5570eade1f6e819cfe02fa9a2">fpc_timebase_delay_us</a> (uint32_t us)</td></tr>
<tr class="memdesc:a7fc231a5570eade1f6e819cfe02fa9a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delay in microseconds.  <a href="#a7fc231a5570eade1f6e819cfe02fa9a2">More...</a><br /></td></tr>
<tr class="separator:a7fc231a5570eade1f6e819cfe02fa9a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac460a539a284d1628a13046259fe18d1"><td class="memItemLeft" align="right" valign="top"><a id="ac460a539a284d1628a13046259fe18d1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__timebase_8h.html#ac460a539a284d1628a13046259fe18d1">fpc_timebase_init</a> (void)</td></tr>
<tr class="memdesc:ac460a539a284d1628a13046259fe18d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes timebase. Starts system tick counter. <br /></td></tr>
<tr class="separator:ac460a539a284d1628a13046259fe18d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Timebase based on a system tick. </p>
<p>Supplies tick counter and wait operation(s). </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ab4344ced36900ee2a274f90fae673b8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4344ced36900ee2a274f90fae673b8d">&#9670;&nbsp;</a></span>fpc_timebase_delay_ms()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fpc_timebase_delay_ms </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ms</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delay in milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>Time to wait [ms]. 0 =&gt; return immediately 1 =&gt; wait at least 1ms etc. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7fc231a5570eade1f6e819cfe02fa9a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fc231a5570eade1f6e819cfe02fa9a2">&#9670;&nbsp;</a></span>fpc_timebase_delay_us()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fpc_timebase_delay_us </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>us</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delay in microseconds. </p>
<p>This function is mainly used to minimize the time spent waiting for the sensor to complete certain operations when running in polling mode. The time accuracy for this function is up to the user to determine depending on latency needs, but it should be at least 100us. If not implemented elsewhere a weak implementation of this function is available in the BEP library that will fall back to using fpc_timebase_delay_ms.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td>Time to wait [us]. 0 =&gt; return immediately 1 =&gt; wait at least 1us etc. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9a06fbb5fce95e153a82d1d6084e31eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a06fbb5fce95e153a82d1d6084e31eb">&#9670;&nbsp;</a></span>fpc_timebase_get_tick()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t fpc_timebase_get_tick </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the system tick counter. </p>
<dl class="section return"><dt>Returns</dt><dd>Tick count since <a class="el" href="fpc__timebase_8h.html#ac460a539a284d1628a13046259fe18d1" title="Initializes timebase. Starts system tick counter. ">fpc_timebase_init()</a> call. [ms] </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0d96f899f92a51a54f2a9daafded85a3.html">req_interface</a></li><li class="navelem"><a class="el" href="dir_2904bb0a4c7630347e1aab62443c90ca.html">inc</a></li><li class="navelem"><a class="el" href="fpc__timebase_8h.html">fpc_timebase.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
